構文図

表 1 は、コマンド・ライン・インターフェース (CLI) コマンドを表現する構文図の読み方を説明しています。説明の中で、CLI コマンド要素を表す記号が定義されています。

表 1. 構文図

要素	構文	説明
メインパス・ライン	>>><>() () ()	メインパス・ラインは、左側の二重矢印 (>>) から開始されます。メインパス・ラインは、右側の相互に向かい合った 2 つの矢印 (><) で終了します。構文図が複数の行になる場合、継続行は 1 つの矢印で終わり、次の行は 1 つの矢印 (>) で開始されます。 構文図は左から右、上から下へ、メインパス・ラインに沿って読んでください。
キーワード		コマンド、フラグ、パラメーター、または引数の名前を表します。キーワードはイタリック体ではありません。キーワードは、構文図に示されているとおりに入力してください。
必須キーワード		コマンドに指定する必要があるパラメーターまたは引数を示します。必須キーワードは、メインパス・ラインに書き込む必要があります。一緒に指定できない必須キーワードは、縦に積み重ねて示されます。
オプション・キーワード		コマンドに選択して指定できるパラメーターまたは引数を示します。オプションのキーワードは、メインパス・ラインの下に書き込む必要があります。相互に排他的なオプション・キーワードは、縦に積み重ねて示されます。
デフォルト値		デフォルト値は、メインパス・ラインの上に書き込む必要があります。
反復可能キーワードまたは値		2 回以上指定できるパラメーターまたは引数を表します。反復可能なキーワードまたは値は、キーワードまたは値の上を右から左へ戻る矢印で示しています。
変数		パラメーターまたは引数に指定する必要のある値 (ファイル名、ユーザー名、パスワードなど) を表しています。変数はイタリック体です。
スペース分離文字		前後のキーワード、パラメーター、引数、または変数を区切るために、メインパス・ラインにブランク・スペースを追加します。
引用符区切り文字		複数の値が含まれるパラメーターまたは引数の始まりと終わりを示します。特定のパラメーターまたは引数の場合、1 つ以上の名前と値の対を二重引用符のセットで囲みます。パラメーター値または名前と値の対にブランクまたは空白文字が含まれる場合は、値全体を単一引用符のセットで囲みます。
等号演算子		名前と値の対の中で、名前とその値を区切ります。
構文フラグメント	Fragment name	非常に長い構文図、複雑な構文図、もしくは繰り返しの多い構文図を分割します。フラグメント名はメインの構文図の中に示されます。実際のフラグメントは、メインの構文図の下に示されます。